﻿#region Copyright
// Copyright (c) 2011-2012 RaisingForce Team (Alikin Sergey)
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
#endregion

using System;
using System.Diagnostics.Contracts;
using RaisingForce.Raise.Measures;

namespace RaisingForce.Raise.Hardware
{
    /// <summary>
    /// Представляет интерфейс доступа к ультразвуковому датчику робота.
    /// <para>Это абстрактный класс по умолчанию для интерфейса <see cref="IRobotSensor"/>.</para>
    /// </summary>
    public abstract class RobotSensor :
        IRobotSensor
    {
        #region Constructors

        /// <summary>
        /// Создает экземпляр класса <see cref="RobotSensor"/>.
        /// </summary>
        /// <param name="hardwareSyncObject">Объект синхронизации для доступа
        /// к открытым членам интерфейса <see cref="IRobotHardware"/>.</param>
        protected RobotSensor(object hardwareSyncObject)
        {
            if (hardwareSyncObject == null)
            {
                throw new ArgumentNullException("hardwareSyncObject");
            }
            Contract.EndContractBlock();
            this.hardwareSyncObject = hardwareSyncObject;
        }

        #endregion

        #region Private Declarations

        private readonly object hardwareSyncObject;

        private readonly object sensorSyncObject = new object();

        [ContractInvariantMethod]
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic", Justification = "Required for code contracts.")]
        private void ObjectInvariant()
        {
            Contract.Invariant(this.hardwareSyncObject != null);
            Contract.Invariant(this.sensorSyncObject != null);
        }

        #endregion

        #region Protected Abstract Declarations

        /// <summary>
        /// Определяет расстояние до ближайшего препятствия,
        /// расположенного прямо перед роботом, с помощью ультразвукового датчика.
        /// <para>Этот метод нужно переопределить в классах-наследниках для
        /// задания логики поведения открытому методу <see cref="DetectObstacle"/>.</para>
        /// </summary>
        /// <returns>Расстояние до ближайшего препятствия,
        /// или Distance.Unknown, если препятствие не обнаружено.</returns>
        protected abstract Distance DetectObstacleHardware();

        #endregion

        #region IRobotSensor Members

        /// <summary>
        /// Определяет расстояние до ближайшего препятствия,
        /// расположенного прямо перед роботом, с помощью ультразвукового датчика.
        /// </summary>
        /// <returns>Расстояние до ближайшего препятствия,
        /// или Distance.Unknown, если препятствие не обнаружено.</returns>
        /// <exception cref="RobotHardwareException">
        /// Произошла ошибка с оборудованием, либо робот не ответил вовремя.
        /// </exception>
        /// <seealso cref="IRobotSensor"/>
        /// <seealso cref="RobotHardwareException"/>
        public Distance DetectObstacle()
        {
            lock (this.hardwareSyncObject)
            {
                lock (this.sensorSyncObject)
                {
                    try
                    {
                        return this.DetectObstacleHardware();
                    }
                    catch (RobotHardwareException)
                    {
                        throw;
                    }
                    catch (Exception ex)
                    {
                        throw new RobotHardwareException(
                            RobotHardwareFailureReason.Hardware,
                            RobotHardwareExceptionMessages.SensorError,
                            innerException: ex);
                    }
                }
            }
        }

        #endregion
    }
}
